home *** CD-ROM | disk | FTP | other *** search
/ Apple WWDC 1996 / WWDC96_1996 (CD).toast / Technology Materials / MacOS 8 Resources / Developer Tools / Mac OS 8 Interfaces & Libraries / Interfaces / CIncludes / TextInputSystem.h < prev    next >
C/C++ Source or Header  |  1996-05-01  |  4KB  |  143 lines
  1. /*
  2.      File:        TextInputSystem.h
  3.  
  4.      Contains:    The handling of text input user interface.
  5.  
  6.      Version:    Technology:    System 8
  7.                  Release:    Universal Interfaces 3.0d3 on Copland DR1
  8.  
  9.      Copyright:    © 1984-1996 by Apple Computer, Inc.  All rights reserved.
  10.  
  11.      Bugs?:        If you find a problem with this file, send the file and version
  12.                  information (from above) and the problem description to:
  13.  
  14.                      Internet:    apple.bugs@applelink.apple.com
  15.                      AppleLink:    APPLE.BUGS
  16.  
  17. */
  18. #ifndef __TEXTINPUTSYSTEM__
  19. #define __TEXTINPUTSYSTEM__
  20.  
  21. #ifndef __TYPES__
  22. #include <Types.h>
  23. #endif
  24. #ifndef __TEXTCOMMON__
  25. #include <TextCommon.h>
  26. #endif
  27. #ifndef __LOCALEOBJECTS__
  28. #include <LocaleObjects.h>
  29. #endif
  30.  
  31. #ifdef __cplusplus
  32. extern "C" {
  33. #endif
  34.  
  35. #if PRAGMA_IMPORT_SUPPORTED
  36. #pragma import on
  37. #endif
  38.  
  39. #if PRAGMA_ALIGN_SUPPORTED
  40. #pragma options align=mac68k
  41. #endif
  42.  
  43. #if FOR_SYSTEM8_COOPERATIVE
  44. /*____________________________________________________________________________________*/
  45. /*
  46.  
  47. Routine:    GetCurrentTextInputLocaleIdentifier
  48.             gets the LocaleIdentifier of the currently selected text input object.
  49. Input:        NONE.
  50. Output:        langRegionCode: the currently selected object.
  51. OSStatus:    (no error, ?)
  52. NOTE:        System8 only.
  53.  
  54. */
  55. extern OSStatus GetCurrentTextInputLocaleIdentifier(LocaleIdentifier *langRegionCode);
  56.  
  57. /*____________________________________________________________________________________*/
  58. /*
  59.  
  60. Routine:    GetCurrentTextInputRef
  61.             gets the current text input object reference.
  62. Input:        NONE.
  63. Output:        textInputObject: the currently selected object.
  64. OSStatus:    (no error, ?)
  65. NOTE:        System8 only.
  66. */
  67. extern OSStatus GetCurrentTextInputRef(LocaleObjectRef *textInputObject);
  68.  
  69. /*____________________________________________________________________________________*/
  70. /*
  71.  
  72. Routine:    SetCurrentTextInputLocaleIdentifier
  73.             sets the current text input object according to the passed-in LocaleIdentifier.
  74. Input:        textInputObject: the object selected by the client.
  75. Output:        NONE.
  76. OSStatus:    (no error, invalide object)
  77. NOTE:        if the object is not shown, it will be displayed in the menu if the system supports
  78.             this language/region/... locale.
  79.  
  80. */
  81. extern OSStatus SetCurrentTextInputLocaleIdentifier(LocaleIdentifier langRegionCode);
  82.  
  83. /*____________________________________________________________________________________*/
  84. /*
  85.  
  86. Routine:    SetCurrentTextInputRef
  87.             sets the current text input object ref.
  88. Input:        textInputObject: the object selected by the client.
  89. Output:        NONE.
  90. OSStatus:    (no error, invalide object)
  91. NOTE:        if the object is not shown, it will be displayed in the menu if the system supports
  92.             this language/region/... locale.
  93. */
  94. extern OSStatus SetCurrentTextInputRef(LocaleObjectRef textInputObject);
  95.  
  96. /*
  97. ____________________________________________________________________________________
  98.     routines for converting between a text input object ref and the new LocaleIdentifier
  99. ____________________________________________________________________________________
  100. */
  101. /*
  102.  
  103. Routine:    GetLocaleIdentifierFromTextInputObjectRef
  104.             returns the LocaleIdentifier textInputObject represents.
  105. Input:        textInputObject:    the reference of text input object.
  106. Output:        langRegionCode:        localeIdentifier that this objects is stamped with.
  107. OSStatus:    (no error, ?)
  108. NOTE:        System8 only.
  109.  
  110. */
  111. extern OSStatus GetLocaleIdentifierFromTextInputObjectRef(LocaleObjectRef textInputObject, LocaleIdentifier *langRegionCode);
  112.  
  113. /*____________________________________________________________________________________*/
  114. /*
  115.  
  116. Routine:    GetTextInputObjectRefFromLocaleIdentifier
  117.             gets the object ref last designated by the user as representing the lanaguag/region
  118.             LocaleIdentifier (or simply returns the default one), otherwise it returns null.
  119. Input:        langRegioncode:        value of LocaleIdentifier.
  120. Output:        textInputObject:    best match returned object.
  121. OSStatus:    (no error, ?)
  122. NOTE:        System8 only.
  123.  
  124. */
  125. extern OSStatus GetTextInputObjectRefFromLocaleIdentifier(LocaleIdentifier langRegionCode, LocaleObjectRef *textInputObject);
  126.  
  127. #endif
  128.  
  129. #if PRAGMA_ALIGN_SUPPORTED
  130. #pragma options align=reset
  131. #endif
  132.  
  133. #if PRAGMA_IMPORT_SUPPORTED
  134. #pragma import off
  135. #endif
  136.  
  137. #ifdef __cplusplus
  138. }
  139. #endif
  140.  
  141. #endif /* __TEXTINPUTSYSTEM__ */
  142.  
  143.